home *** CD-ROM | disk | FTP | other *** search
/ Windows Expert / Windows Expert.iso / database / ehi10.zip / MANUAL.DOC < prev    next >
Text File  |  1993-08-30  |  21KB  |  500 lines

  1.  
  2.                        Essential Home Inventory
  3.  
  4.                         Version 1.0 Test Drive
  5.  
  6.                               User Guide
  7.  
  8.  
  9.  
  10. Essential Home Inventory is the ideal companion for keeping track of all
  11. the items in your house or running a small business in your home. You can
  12. never tell when disaster will strike and you NEED this information, and
  13. this program is designed to be as painless and simple as possible to aid
  14. you in cataloguing your belongings or small business inventory. We've also
  15. added some features to make EHI flexible enough to do other tasks as well,
  16. such as cataloguing your coin collections and so on. Careful use of this
  17. program will also allow you to perform basic financial analyses and get a
  18. grip on what you own. You can also reconfigure it to keep other data as
  19. well such as phone/address books. See the supplied examples. In short,
  20. EHI is a very simple program that not only does it's primary task (keeping
  21. track of your belongings) but also can be used for a wide (and surprising)
  22. variety of purposes.
  23.  
  24. This short manual will give you the basics of what buttons and menu items
  25. do what, but the better learning experience is to run the program and look
  26. at the supplied example data files. Enjoy!
  27.  
  28.                      --- G.L. Alston / Summer 1993
  29.  
  30.  
  31. I. TEST DRIVE INSTALLATION
  32.  
  33. Unpack the archive file in a separate directory. Take the *.VBX files
  34. and any *.DLL files and place them in your WINDOWS\SYSTEM directory.
  35. Most of you have this on drive C:. An example? Sure? Let's say that you
  36. have put a copy of the ZIP file in D:\EHI:
  37.  
  38. D:\EHI> copy *.vbx c:\windows\system
  39. D:\EHI> copy *.dll c:\windows\system
  40.  
  41. (Start Windows)
  42.  
  43. D:\EHI> win
  44.  
  45. Once Windows is started, open the FILE menu in the PROGRAM MANAGER.
  46. Select NEW. Select PROGRAM ITEM, choose OK. Enter the following:
  47.  
  48. Description:   Essential Home Inventory
  49. Command Line:  EHI.EXE
  50. Directory:     D:\EHI  <----- in keeping with our example!
  51. Shortcut Key:  (none)
  52.  
  53. Select OK. The program will now be installed, and you can double-click the
  54. icon to start as you would any other program.
  55.  
  56. A short aside:
  57.  
  58. What a pain, huh? Sorry, but Windows installers take up too much room, and
  59. the name of the game in shareware distribution is DISTRIBUTION. The bottom
  60. line is that the blasted installer takes up too much room for easy and fast
  61. distribution. It's no sweat to add 150k to a floppy, but who wants to
  62. download that? If you buy this program you'll get a real installer. We know
  63. how to do it. Honest. No, seriously...
  64.  
  65.  
  66. II. GETTING STARTED
  67.  
  68. Two important concepts to master here, and that's it. This is a very
  69. simple, no nonsense program.
  70.  
  71. DATABASES:
  72.  
  73. A database uses the concept that information will always follow a given
  74. format.  This format breaks down the individual pieces of information
  75. into blocks called "fields." Each group of FIELDS is called a "Record."
  76. As a 'for instance', take the case of a mailing list:
  77.  
  78.  
  79.                    /       Name         <--- One Field
  80.                   |        Street
  81.       1 RECORD   <         City
  82.                   |        Zip
  83.                    \       Phone
  84.  
  85.  
  86. The above constitutes a RECORD. Each line of information is a FIELD. In 
  87. the case of a mailing list, the database uses the same format for each 
  88. and every RECORD, although the information in each FIELD will change 
  89. depending on the RECORD viewed. A Rolodex (tm) is a database.
  90.  
  91.  
  92. TEMPLATES:
  93.  
  94. A template is little more than a how a series of fields fit together
  95. for a particular collection. In this program there is a series of 10
  96. fields that you can define the name, purpose, and data type. Is this text,
  97. or is this a number? There is also a pick list that you can use. The pick
  98. list is a very powerful item in a data management tool. Rather than type
  99. in redundant information record after record, a pick list simplifies
  100. common data entry and keeps spelling error minimised. Take a look at a
  101. sample file or two (provided on the distributon disk) to see how pick
  102. lists are implemented. Essentially, the pick list is the definitive
  103. categorization for any inventory or listing.
  104.  
  105. It's not required to use all available fields, either. The important 
  106. thing to know is that the template can be set up easily by YOU to work
  107. with the type of data you need.
  108.  
  109.  
  110. III. MORE THEORY AND OTHER NOTES
  111.  
  112. Print Mask:
  113.  
  114. EHI uses a PRINT MASK at any time data is printed. Simply put, the
  115. print mask allows you to select what does and what does not get printed.
  116. This is useful for a variety of purposes, such as printing a catalogue
  117. but omitting the PRICE PAID field so that prying eyes don't know what
  118. was paid for an item. Also, since EHI stores pictures as well, you
  119. may not want a catalogue full of pictures. Manipulating the print mask
  120. is very simple: when you get the print mask setup window, just click the
  121. check box next to fields whose information is NOT to be printed. Think of
  122. a print mask as being like like masking tape.
  123.  
  124. Addendum Files:
  125.  
  126. EHI allows you to append pictures and text to EACH record. This is
  127. information that is too big to try to put ALL of the possible pictures in
  128. memory at once. Addendum files are simply filenames that you specify that
  129. hold any information about a given item. You can see the use of these in
  130. some of the example files. Each record stores the addendum filename that
  131. is germane to that record, and each one actually used should be unique.
  132.  
  133. In actual practice, the use of these make EHI more flexible than you may
  134. realise. A description can only go so far, and a picture may be what is
  135. needed to show an insurance agent just how good the condition of an item
  136. really was.
  137.  
  138. Each text addendum can hold up to 30k of data, and it can be imported
  139. from other applications. The data itself can be letters, instructions,
  140. lists, and so on. 
  141.  
  142.  
  143. RAM Based Data:
  144.  
  145. EHI is RAM based, meaning that most all operations are carried out
  146. in the fastest possible manner. Most data management products use the
  147. disk as the file source and read data from the file as needed. This can
  148. be slow. This is how EHI can search for many items at the same time (i.e.
  149. a complex search) and still do it quicker than anything else out there.
  150.  
  151. The offset to this is a record per file limit of 5000 records. While on
  152. the surface this sounds like a low amount, in practice it is more than
  153. enough to work with the average household collection. Since EHI can work
  154. with an unlimited number of files, we've put a lot of emphasis on the
  155. ability to manage these properly.
  156.  
  157. File Management:
  158.  
  159. Above we talked about the speed of EHI searches. These can be quite
  160. complex, using matching, inequality (i.e. less than or more than), or
  161. range. Once you find your data, what do you do with it? For starters, 
  162. you can remove it from the present file and place it into another, or
  163. you can append a copy to another file. Kids move away from home, accidents
  164. happen, and so on; a program ought to be able to reflect real life.
  165.  
  166.  
  167. IV. OPERATING
  168.  
  169. The Scroll Bar (on screen left) is used to move the view from record to
  170. record. The Add and Delete buttons are used to Add and Delete complete
  171. records.
  172.  
  173. The four pushbuttons with icons:
  174.  
  175. Graphics -- this will show any picture file associated with the record
  176. that is on screen at the time. There MUST be a valid DOS filename in the
  177. RED "Addendum Name" field.
  178.  
  179. Text -- this will show any text file associated with the record that is
  180. on screen at the time. There MUST be a valid DOS fielname in the RED
  181. "Addendum Name" field.
  182.  
  183. Statistics --  this is used to access and view statistical information.
  184.  
  185. Clipboard -- this is used to temporarily hold information from a record
  186. (by copying) so that you can do less typing by duplicating it (pasting)
  187. into an empty record.
  188.  
  189. The following is the instructions for the main menu. The convention used
  190. here is the menu item, a separator, and the subitem. An asterisk (*) will
  191. alert you to any notes. The menu follows standard Windows conventions,
  192. including the use of accelerator (shortcut) keys. Items that include an
  193. ellipses (...) will bring up another window.
  194.  
  195. FILE
  196.  
  197. The file menu allows you to create, open, save, print, and rename data
  198. files, and EXIT the program.
  199.  
  200. FILE | NEW -- allows you to create a new data file from scratch. You will
  201. need to choose the template used from the file dialog box. 
  202.  
  203. FILE | OPEN -- shows you a file dialog so that you can choose a file to
  204. open. 
  205.  
  206. FILE | SAVE -- saves an opened data file.
  207.  
  208. * if OPTIONS | FILE BACKUPS MADE has been checked, a backup file of the
  209. same data will be written to the disk as FILENAME.BAK
  210.  
  211. FILE | SAVE AS -- allows you to save the open data file to disk under
  212. another name.
  213.  
  214. * if OPTIONS | FILE BACKUPS MADE has been checked, a backup file of the
  215. same data will be written to the disk as FILENAME.BAK
  216.  
  217. FILE | EXPORT -- writes the open data file to the disk as a comma
  218. delimited ASCII file readable by a database or spreadsheet program. 
  219. An extension of *.CSV will be appended; it will write as FILENAME.CSV
  220.  
  221. FILE | PRINT
  222.  
  223. FILE | PRINT | CURRENT RECORD -- prints the record shown on screen, using
  224. the print mask.
  225.  
  226. FILE | PRINT | ALL RECORDS -- prints the entire data file, using the print
  227. mask. 
  228.  
  229. FILE | PRINT | LAST SEARCH -- when enabled, this will print all items 
  230. found in the last search that was made using the print mask.
  231.  
  232. FILE | EXIT -- Quits Program and returns to Windows
  233.  
  234.  
  235. EDIT
  236.  
  237. The edit menu is only active when either the TEXT or GRAPHICS addendum
  238. window is active. The top seven items pertain to TEXT operations, and
  239. the bottom three apply to graphics-only operations. Note that the menu 
  240. items are disabled when they are not pertinent. For instance, PASTE 
  241. will be grayed out (disabled) if there is no text in the Windows 
  242. Clipboard to paste with. Text operations are Windows standard, i.e. 
  243. selecting, etc. If you do not know how to select text in Windows, please 
  244. refer to your Windows 3.x operation guide.
  245.  
  246. EDIT | UNDO -- this will "undo" a previous CUT or DELETE operation, and
  247. acts as an "oops" selection for unintentional deletions. 
  248.  
  249. EDIT | COPY -- this will copy any selected text to the Windows 
  250. Clipboard.
  251.  
  252. EDIT | CUT -- this will copy any selected text to the Windows Clipboard
  253. and remove it from the screen.
  254.  
  255. EDIT | PASTE -- this will take text from the Windows Clipboard and place
  256. it into the text window at the cursor position.
  257.  
  258. EDIT | DELETE -- this will remove text from the screen. You can change
  259. your mind and choose UNDO to reverse the operation, but deleted text
  260. does NOT go to the Windows Clipboard.
  261.  
  262. EDIT | IMPORT TEXT -- this allows you to read a separate text file and
  263. add the contents to the text window. The File Open dialog will default
  264. to the "*.TXT"  extension (in keeping with Windows Notepad conventions) 
  265. but it will read in ASCII text using any oher extension.
  266.  
  267. EDIT | SAVE TEXT -- saves the text in the text window to the file 
  268. specified by the "Addendum Name" data field. NOTE: EHI DOES NOT
  269. AUTO-SAVE TEXT OR GRAPHICS ADDENDA FILES. THESE **MUST** BE SAVED BY
  270. USING THE "SAVE TEXT" OR "SAVE GRAPHIC" MENU ITEMS. 
  271.  
  272. EDIT | IMPORT GRAPHIC -- See IMPORT TEXT above. The default extension
  273. for importing graphics files is *.BMP, but files of WMF, RLE, or ICO
  274. format can also be read.
  275.  
  276. EDIT | COPY GRAPHIC -- allows you to copy any graphic in the window
  277. to the Windows Clipboard.
  278.  
  279. EDIT | SAVE GRAPHIC -- See SAVE TEXT above. Same rules.
  280.  
  281.  
  282. FIND
  283.  
  284. The FIND menu caters to searching operations. It allows you to bring
  285. up the search window, and after a search is made, manipulate the data.
  286. Menu items are disabled (grayed out) if they cannot be used. 
  287.  
  288. FIND | NEW SEARCH -- brings up the SEARCH window.
  289.  
  290. FIND | COPY TO EXISTING FILE -- this allows found data to be copied 
  291. from the open data file into another existing data file. You will need
  292. to pick a filename from the file dialog box that appears.
  293.  
  294. **IMPORTANT**
  295.  
  296. EHI does not check to see if the file you are copying data to
  297. uses the same template as the currently open file. It is up to you
  298. and your file naming practice to put data into similar files.
  299.  
  300. FIND | COPY TO NEW FILE -- this will allow you to name a new data file,
  301. and EHI will create it and copy the found data into it. It also causes
  302. the new file to use the same template as the currently opened file.
  303.  
  304. FIND | EXPORT -- this creates a comma delimited ASCII (*.CSV) file 
  305. that can be read by database and spreadsheet products. You will be 
  306. asked to provide a name for the new file, and EHI will append
  307. the extension for you. The file on disk will be FILENAME.CSV.
  308.  
  309. FIND | MOVE TO EXISTING FILE -- 
  310. AND
  311. FIND | MOVE TO NEW FILE -- 
  312.  
  313. See COPY TO EXISTING / NEW FILE above. The difference between COPY and
  314. MOVE is that MOVE will remove the data from the opened file and place 
  315. it into the EXISTING or NEW file (whichever was specified.) COPY simply
  316. places a copy of the data into the file and leaves the data in the 
  317. oringinal opened file intact.
  318.  
  319.  
  320. OPTIONS
  321.  
  322. The OPTIONS menu allows you to edit and create templates, specify
  323. file writing and printing options, and set up the print mask.
  324.  
  325. OPTIONS | EDIT TEMPLATE -- this brings up a file dialog allowing you
  326. to choose an existing template to edit. See TEMPLATE EDITOR.
  327.  
  328. OPTIONS | CREATE NEW TEMPLATE -- this will bring up a dialog to create
  329. a new file name before bringing up the edit template window. See
  330. TEMPLATE EDITOR.
  331.  
  332.  
  333. OPTIONS | FILE OVERWRITE CHECKING -- when on: this is used when you are
  334. writing an addendum file to disk. When saving, the disk is checked to 
  335. see if another file of the same name exists. If so, you will be asked
  336. if you wish to overwrite the file. When this is off, addendum files are
  337. written to disk without checking first.
  338.  
  339. * This is an option that is TRUE or ON when checked.  
  340.  
  341. OPTIONS | FILE BACKUPS MADE -- when on: when data files are saved to
  342. disk, this will create a new file on disk that is a duplicate of the
  343. original. The extension *.BAK is used. 
  344.  
  345. * This is an option that is TRUE or ON when checked.
  346.  
  347. OPTIONS | PRINT USING MASK -- when on: enables use of the PRINT MASK.
  348.  
  349. * This is an option that is TRUE or ON when checked.
  350.  
  351. OPTIONS | SET UP MASK -- this brings up the PRINT MASK SETUP window.
  352.  
  353.  
  354. HELP
  355.  
  356. This menu allows you to access the online help, print this manual, and
  357. place an order for the enhanced version.
  358.  
  359.  
  360. HELP | TOPICS -- brings up the online help window.
  361.  
  362. HELP | ORDER INFO -- brings up the order form window.
  363.  
  364. HELP | ABOUT -- Who is responsible for this, anyhow?
  365.  
  366.  
  367.  
  368. V.  TEMPLATE CREATION USING THE TEMPLATE EDITOR
  369.  
  370. In the template editor there are ten fields and a pick list. Each of
  371. these are defined by you. The fields can be either TEXT or NUMERIC
  372. depending on which option you choose for each field. The text window
  373. inside each frame is for you to give the field a name. This name should
  374. be as descriptive as possible, and can be up to 35 characters long. If
  375. a name is over 35 characters long, you won't be able to save the file.
  376.  
  377. The pick list is for entering the primary categorization of the item
  378. that the template is about. By all means look at the supplied sample
  379. files to see how this is done. The purpose of the list is to keep the
  380. entry of your inventory data simple. It also serves another purpose:
  381. you cannot misspell something chosen from a list when searching.
  382.  
  383. Adding to the list is simple: just type what you want it to say in the
  384. text box above the list, and choose ADD. The new item will be added to
  385. the bottom of the list. Deleting a list item is also simple: choose the 
  386. item from the list to delete so that it shows up in the list box window, 
  387. and choose DELETE.
  388.  
  389. When you are done editing or creating the template, choose SAVE.
  390.  
  391.  
  392.  
  393. VI. SETUP AND USE OF THE PRINT MASK
  394.  
  395. In the Print Mask window, you are shown a list of the available fields
  396. next to check boxes. To prevent this item from being printed, simply
  397. click the check box (an "x" will appear in it.) You can also click it 
  398. again to uncheck it if you change your mind. The CLEAR button will 
  399. uncheck all fields thus allowing EVERYTHING to get printed. The DEFAULT
  400. button will check the VALUE, PICTURE, and COMMENT TEXT items. OK will
  401. accept all entries and close the window.
  402.  
  403. Notes:
  404.  
  405. Printing picture files takes time, and a new page of paper is always
  406. used (to place the picture in the desired position. Likewise, printing
  407. the text addenda files also takes more time. These items default to NOT
  408. being printed since they are usually not used when creating a general
  409. catalogue.
  410.  
  411.  
  412. VII. SEARCHING
  413.  
  414. In the search window, the fields have a check box next to them. Clicking
  415. a check box will tell EHI that a search can be made. This brings up
  416. a CRITERIA window that allows you to enter the data to sarch for. If the
  417. field is numeric, you can search for MATCHING values, values LESS THAN or
  418. GREATER THAN what you entered, or you can enter 2 values to initiate a
  419. search for range: GREATER THAN the first value, and LESS THAN the second.
  420. Text fields and lists are searched for MATCHING values only. If it is a
  421. text field, the other options are disabled in the criteria window. Note
  422. the IGNORE CASE check box: this will allow you to specify whether the
  423. search should look for text EXACTLY as you typed it, or if it should
  424. ignore letter capitalizing. When you are done filling in the values to
  425. look for, just choose OK to close the criteria window.
  426.  
  427. All fields can be searched and the same process takes place on each one.
  428. If you choose a check box that has already been marked, this has the effect
  429. of clearing it. Just choose it again to re-enter a new search criteria.
  430.  
  431. If you choose the CLEAR button, all fields are forced into the unchecked
  432. state and any search criteria is erased. If you choose the SEARCH button,
  433. a search will be made through the data file on the checked fields.
  434.  
  435. Choosing DONE will close the window, but not erase it -- if you re-open
  436. the window, it will be as you left it. This way you can either close or
  437. minimize the window (and place it on the desktop) and not lose any data.
  438.  
  439. When a search is made, EHI calculates the number of records found and
  440. shows them in the window. A scroll bar will appear that will allow you to
  441. scroll through the found records -- these will show up in the main window.
  442. As you scroll through, the main window scroll bar also changes to show a
  443. relative file position.
  444.  
  445. You can switch back and forth between the windows as desired, and operate
  446. either scroll bar at any time. Just remember that the one in the search
  447. window scrolls only through records found in the search.
  448.  
  449. See the description of menu operations about how to take found data and
  450. copy or move it from the current file.
  451.  
  452.  
  453. VIII. SHAREWARE, DISCLAIMERS, AND CONTACT INFO
  454.  
  455. You have an implicit license to EVALUATE this program for a reasonable
  456. period of time to see if it meets your needs. We figure 45 days or so is
  457. pretty reasonable because it lets you take your time: no pressure! If you
  458. want to use it beyond this time, you'll need to order the registered
  459. version, which gives you a license to use it forever. If you don't want to
  460. register it, you'll need to remove it from your system. It's illegal after
  461. that to use it. Seriously. This is copyrighted software, just like the stuff
  462. in the stores. We prefer to work this way though, because we get closer to
  463. the average users, and it helps us write better programs. To sweeten the pot
  464. a bit (we try to make it worth your while) you'll get lots of extra goodies
  465. when you buy the program. (Hint: if you think it's fast and easy now,
  466. well... it's even better!)
  467.  
  468. See the help file while in the program for details. There's a lot of stuff
  469. that you'll get as a registered owner.
  470.  
  471.  
  472. Standard Software Industry Disclaimer:
  473.  
  474. Alston Software Labs makes no claim or warranty whatsoever as to the
  475. fitness or suitability to purpose of Essential Home Inventory.
  476.  
  477. Contact Information:
  478.  
  479. Alston Software Labs
  480. 1320 Standiford Ave #242
  481. Modesto CA 95350
  482. Tel (209) LAB - 8666
  483. FAX (209) 522 - 8666
  484.  
  485.     (800) 959 - 6298 Orders Only
  486.  
  487. Compuserve: 76040,2247
  488. GEnie     : G.ALSTON5
  489. Internet  : 76040.2247@compuserve.com
  490.  
  491. Or try our home BBS in Modesto, The Programmer's Retreat @ (209) 526-9987
  492. to get the latest versions or other ASL software. Just log in, use ASL for
  493. the password.
  494.  
  495. Essential Home Inventory and this manual are copyright 1993 by Alston
  496. Software Labs, Modesto, CA.
  497.  
  498. Windows is a registered trademark of Microsoft Corporation, Redmond, WA.
  499.  
  500.